Expand README into developer documentation - #43
Merged
Conversation
Previously just a title and build badge. Added an overview of the three packages, installation instructions, a quick start, and sections covering document parsing/serialization, whole-document validation (OADocumentValidator, OAExampleDocuments), building requests with OpenAPI-Client (including the parameter style/explode matrix), and an honest "what is (not yet) supported" section - mirroring JSONSchema's README structure and level of detail. Every code example was verified against the live image before being written down (parsing, validating, building a client subclass and firing a real call, the exact error-class hierarchy raised on failure) rather than written from memory. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Previously just a title and build badge. Added an overview of the three packages, installation instructions, a quick start, and sections covering document parsing/serialization, whole-document validation (OADocumentValidator, OAExampleDocuments), building requests with OpenAPI-Client (including the parameter style/explode matrix), and an honest "what is (not yet) supported" section - mirroring JSONSchema's README structure and level of detail.
Every code example was verified against the live image before being written down (parsing, validating, building a client subclass and firing a real call, the exact error-class hierarchy raised on failure) rather than written from memory.